Node2D is the base class of 2D nodes. More...
#include <kanzi/core.ui/node/node2d.hpp>
Classes | |
| struct | ClippingArea |
| Clipping information carried from parents. More... | |
Public Member Functions | |
| bool | addAbstractChildOverride (NodeSharedPtr child) override |
| Node::addAbstractChildOverride() implementation. | |
| void | addChild (Node2DSharedPtr child) |
| Adds a child node. | |
| void | arrange () |
| Performs layout arrangement on a 2D node. | |
| ChildConstIterator | beginChildren () const |
| bool | compositionRequiresAlpha () const |
| Returns whether composition requires alpha. | |
| bool | compositionRequiresDepth () const |
| Returns whether composition requires depth. | |
| bool | compositionRequiresStencil () const |
| Returns whether composition requires stencil. | |
| optional< Vector2 > | containsGlobal (Vector2 point) const |
| Checks whether a node area contains a point defined in screen space. If it does, writes the node-space coordinates into the outgoing point. | |
| bool | containsLocal (Vector2 point) const |
| Returns whether a node area contains a point defined in the local space of the node. | |
| ChildConstIterator | endChildren () const |
| NodeSharedPtr | findAbstractChildOverride (string_view name) override |
| Node::findAbstractChildOverride() implementation. | |
| size_t | getAbstractChildCountOverride () override |
| Node::getAbstractChildCountOverride() implementation. | |
| size_t | getAbstractChildIndexOverride (const Node &node) override |
| NodeSharedPtr | getAbstractChildOverride (size_t index) override |
| Node::getAbstractChildOverride() implementation. | |
| Vector2 | getActualSize () const |
| Gets the actual size of a node. | |
| Vector2 | getAllocatedSize () const |
| Gets the allocated size of a node. | |
| Matrix3x3 | getArrangeTransform () const |
| Gets the arrange transform. | |
| BrushSharedPtr | getBackgroundBrush () const |
| Gets value of BackgroundBrushProperty. | |
| BrushRenderer * | getBackgroundBrushRenderer () const |
| Get background brush renderer. | |
| QuadDescription | getBackgroundQuad () const |
| Gets the background quad description. | |
| Node2DSharedPtr | getChild (size_t index) const |
| Returns a child from given index from object node. | |
| Matrix3x3 | getChildCompositionSpaceTransform () const |
| Gets the transform used for composition children of the 2D node. | |
| size_t | getChildCount () const |
| Gets the number of children of the node. | |
| size_t | getChildIndex (const Node &child) const |
| Returns the index of a child in an object node. | |
| ClippingArea | getClippingArea () const |
| Gets the clipping area. | |
| BrushSharedPtr | getCompositionBrush () const |
| Gets value of CompositionBrushProperty. | |
| BrushRenderer * | getCompositionBrushRenderer () const |
| Access cache result brush renderer. | |
| CompositionManager * | getCompositionManager () const |
| Access composition manager. | |
| TextureSharedPtr | getCompositionTarget () const |
| Gets the composition target used for compositing the node. | |
| NodeCompositor2D * | getCompositor () const |
| Accesses the compositor component. | |
| Vector2 | getContentDesiredSize () const |
| Gets the size desired by content. | |
| Vector2 | getDesiredSize () const |
| Gets the desired size of a node. | |
| NodeEffect2DSharedPtr | getEffect () const |
| Gets the value of EffectProperty. | |
| NodeEffectPrefab2DSharedPtr | getEffectPrefab () const |
| Gets the value of EffectPrefabProperty. | |
| NodeEffectRenderer2D * | getEffectRenderer () const |
| Gets the effect renderer. | |
| BrushSharedPtr | getForegroundBrush () const |
| Gets value of ForegroundBrushProperty. | |
| BrushRenderer * | getForegroundBrushRenderer () const |
| Get foreground brush renderer. | |
| float | getLayoutOpacity () const |
| Gets the opacity after propagation from layouting hierarchy. | |
| SRTValue2D | getLayoutTransformation () const |
| Gets the value of the LayoutTransformationProperty. | |
| TextureSharedPtr | getManagedCompositionTarget () const |
| Gets the managed composition target of a node. | |
| Matrix3x3 | getParentSpaceTransform () const |
| Gets the parent space transform of the 2D node. | |
| Matrix3x3 | getPartialArrangeTransform () const |
| Gets the partial arrange transform. | |
| NodeEffect2D * | getRenderableEffect () const |
| Gets a pointer to the current effect if effect rendering is required. | |
| Matrix3x3 | getRenderQuadTransform () const |
| Gets transformation used to render the 2D node. | |
| TextureSharedPtr | getRenderTarget () const |
| Gets value of RenderTargetProperty. | |
| SRTValue2D | getRenderTransformation () const |
| Gets the value of RenderTransformationProperty. | |
| RenderType | getRenderType () const |
| Get render type. | |
| Vector2 | getSecondPassDesiredSize () const |
| Gets the second pass desired size. | |
| Vector2 | getUserDesiredSize () const |
| Gets the size desired by user. | |
| NodeVisual2D * | getVisual () const |
| Access visual component. | |
| Matrix3x3 | getWorldTransform () const |
| Gets the world transformation matrix. | |
| optional< Vector2 > | globalToLocal (Vector2 point) const |
| bool | hasCenterClipArea () const |
| Returns whether a 2D node has the center clip area (the area of foreground content). | |
| bool | hasChild (const Node &child) const |
| Returns whether the given node is a child of this node. | |
| bool | hasCompositionTarget () const |
| Indicates whether the node has a composition target. | |
| bool | hasEffect () const |
| Whether an active effect is applied to this node. | |
| bool | hasManagedCompositionTarget () const |
| Returns whether the node has a managed composition target. | |
| bool | hasOutsideClipArea () const |
| Returns whether a 2D node has outside clipping area. | |
| bool | hasTranslucentForeground () const |
| Returns whether the foreground of a 2D node has translucency. | |
| NodeSharedPtr | hitTest (Vector2 point) |
| Performs a hit test to a 2D node and all its child nodes. | |
| template<typename T > | |
| shared_ptr< T > | hitTest (Vector2 point) |
| Wrapper for hitTest(Vector2), casts the return value. | |
| NodeSharedPtr | hitTest (Vector2 point, const Metaclass *type) |
| Performs a hit test to a 2D node and all its child nodes. | |
| template<typename T > | |
| shared_ptr< T > | hitTest (Vector2 point, const Metaclass *type) |
| Wrapper for hitTest(Vector2, const Metaclass), casts the return value. | |
| virtual tuple< NodeSharedPtr, Ray, float > | hitTestContent (Vector2 point) |
| Default implementation of Node2D content hit test. | |
| NodeSharedPtr | hitTestIterate (Vector2 point, HitTestVisitor visitor, void *userData) |
| Hit tests nodes recursively from this node downwards and calls visitor function on the hit nodes. | |
| void | insertChild (size_t index, Node2DSharedPtr child) |
| Adds a child node for object node to given index. | |
| bool | isCacheValid () const |
| Returns whether the children cache is valid. | |
| bool | isClearColorAllowed () const |
| Returns whether this Node2D is allowed and should clear the color buffer of its own composition target. | |
| bool | isCompletelyClipped () const |
| Returns whether a node is completely clipped and needs not be rendered. | |
| bool | isCompletelyTransparent () const |
| Returns whether a node is completely transparent. | |
| bool | isCompositionPotentiallyRequired () const |
| Tell if node itself is going to get rendered into a composition target. | |
| bool | isPerspectiveTransformActive () const |
| Returns whether a node is being perspective transformed. | |
| bool | isRenderChildrenAllowed () const |
| Returns whether rendering children is allowed. | |
| bool | isRenderSelfAllowed () const |
| Returns whether render self is allowed. | |
| bool | isSelfInCompositionTarget () const |
| Returns whether the node is going to get rendered into a composition target. | |
| bool | isVisibleForHitTesting () const |
| Returns whether a 2D node is visible for hit testing. | |
| void | layout () |
| Does layout pass with no root transformation (identity). | |
| void | layout (optional< Matrix3x3 > rootTransform) |
| Does a layout pass starting from this node and iterating recursively all of its children. | |
| bool | measure (const Vector2 *availableSize, bool handleStretch) |
| Measures one node. | |
| virtual bool | measureRecursive () |
| Performs measure recursively. | |
| bool | moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override |
| Node::moveAbstractChildToPosition() implementation. | |
| void | moveChildToPosition (Node2DSharedPtr child, size_t index) |
| Moves a child node to a given position in the list of child nodes. | |
| void | moveToBack () |
| Repositions the node to the beginning of its parent's children, so that it is drawn first. | |
| void | moveToFront () |
| Repositions the node to the end of its parent's children, so that it is drawn last. | |
| ChildConstReverseIterator | rbeginChildren () const |
| bool | removeAbstractChildOverride (Node &child) override |
| Node::removeAbstractChildOverride() implementation. | |
| void | removeAllChildren () |
| Removes all child nodes. | |
| void | removeChild (const Node &child) |
| Removes child node. | |
| void | removeChild (size_t index) |
| Removes child node at specified index. | |
| ChildConstReverseIterator | rendChildren () const |
| void | render (Renderer3D &renderer, CompositionStack &compositionStack) |
| Render a node and its descendant nodes. | |
| void | render (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform) |
| Renders a node and its descendant nodes. | |
| bool | requiresBackgroundBrushRendering () const |
| Returns whether background brush rendering is required. | |
| bool | requiresForegroundBrushRendering () const |
| Returns whether foreground brush rendering is required. | |
| bool | requiresLocalTransformationScope () const |
| Indicates whether local transformation scope is required. | |
| bool | requiresTilingUpdate () const |
| Returns whether node geometry requires an update for the tiling. | |
| void | resetCache () |
| Resets cached content for complete content of a node, including the node and its children. | |
| void | setActualSize (float sizeX, float sizeY) |
| Sets the actual size of a node. | |
| void | setActualSize (Vector2 actualSize) |
| Sets the actual size of a node. | |
| void | setAllocatedSize (Vector2 allocatedSize) |
| Sets the allocated size of a node. | |
| void | setArrangeTransform (Matrix3x3 transform) |
| Sets the arrange transform. | |
| void | setAutoHeight () |
| Sets a node to determine its height automatically. | |
| void | setAutoSize () |
| Sets a node to determine its width and height automatically. | |
| void | setAutoWidth () |
| Sets a node to determine its width automatically. | |
| void | setBackgroundBrush (BrushSharedPtr value) |
| Sets value of BackgroundBrushProperty. | |
| void | setClearColorAllowed (bool enabled) |
| Sets clear color allowed. | |
| void | setCompositionBrush (BrushSharedPtr value) |
| Sets value of CompositionBrushProperty. | |
| void | setCompositionRequested (bool enabled) |
| Turns the composition request on or off. | |
| void | setCompositionRequiresAlpha (bool enabled) |
| Turns the composition alpha requirement on or off. | |
| void | setCompositionRequiresDepth (bool enabled) |
| Turns the composition depth requirement on or off. | |
| void | setCompositionRequiresStencil (bool enabled) |
| Turns the composition stencil requirement on or off. | |
| void | setDesiredSize (Vector2 desiredSize) |
| Sets the desired size of a node. | |
| void | setEffectPrefab (NodeEffectPrefab2DSharedPtr value) |
| Sets the value of EffectPrefabProperty. | |
| void | setForegroundBrush (BrushSharedPtr value) |
| Sets value of ForegroundBrushProperty. | |
| void | setForegroundIsTranslucent (bool enabled) |
| Sets the status of the foreground translucency. | |
| void | setForegroundTranslucencyRequested (bool enabled) |
| Enables or disables the foreground translucency request. | |
| KZ_DEPRECATED void | setLayoutSize (float width, float height) |
| Sets size properties of the node. | |
| void | setLayoutTransformation (SRTValue2D value) |
| Sets the value of the LayoutTransformationProperty. | |
| void | setPotentialCompositionBitViewport (bool enabled) |
| Turns the potential composition flag for the viewport on or off. | |
| void | setRenderTarget (TextureSharedPtr texture) |
| Sets value of RenderTargetProperty. | |
| void | setRenderTransformation (SRTValue2D value) |
| Sets the value of RenderTransformationProperty. | |
| void | setRequiresLocalTransformationScope (bool enabled) |
| Sets the local transformation scope requirement. | |
| void | setRequiresTilingUpdate (bool enabled) |
| Sets the tiling update requirement. | |
| void | setSize (float width, float height) |
| Sets the size of a node. | |
| void | setSize (Vector2 size) |
| Sets the size of a node. | |
| void | transform () |
| Transforms a 2D node. | |
| VisitorResult | visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override |
| Node::visitAbstractChild implementation. | |
| ~Node2D () override | |
 Public Member Functions inherited from kanzi::Node | |
| ResourceSharedPtr | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. | |
| ResourceManager::AcquireTaskSharedPtr | acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const |
| Posts an asynchronous task to acquire a resource. | |
| ResourceDictionarySharedPtr | acquireResourceDictionary () |
| Gets a resource dictionary of a node. | |
| void | addAnonymousResource (ResourceSharedPtr resource) |
| Adds alias resource to an object node. | |
| void | addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator) |
| Transfers the ownership and attaches an input manipulator to an object node. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message handler where the handler is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message handler where the handler is a method that is invoked on an object. | |
| void | addNodeComponent (NodeComponentSharedPtr nodeComponent) |
| Transfers the ownership of a node component to an object node. | |
| void | addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner) |
| Transfers the ownership of a node component to an object node and sets the owner of the node component. | |
| void | addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference) |
| void | addResource (const ResourceID &resourceId, string_view resourceUrl) |
| Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. | |
| void | addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Adds a nested resource dictionary to the resource dictionary of a node. | |
| void | addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| AppliedStyleEntrySharedPtr | applyManualStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| AppliedStyleEntrySharedPtr | applyStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| void | applyStyles () |
| Apply all styles for an object node. | |
| void | applyStylesRecursive () |
| Applies styles recursively. | |
| void | attachRecursive () |
| Attaches an object node and its children recursively. | |
| InputManipulatorConstIterator | beginInputManipulators () const |
| NodeComponentConstIterator | beginNodeComponents () const |
| void | clearChangeFlag (uint32_t flag) |
| Clears a change flag. | |
| void | clearChildChangeFlag (uint32_t flag) |
| Clears a child change flag. | |
| bool | containsResource (const ResourceID &resourceID) const |
| Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. | |
| BindingLookupContextPtr | createLookupContext (NodeSharedPtr templateRoot) |
| Creates a lookup context for the node. | |
| void | detachRecursive () |
| Detaches a node and its descendants. | |
| void | dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| template<typename TArgumentsType > | |
| void | dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| InputManipulatorConstIterator | endInputManipulators () const |
| NodeComponentConstIterator | endNodeComponents () const |
| template<typename TNodeType > | |
| shared_ptr< TNodeType > | findAbstractChild (string_view name) |
| Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. | |
| optional< string > | findResourceURL (const ResourceID &resourceId) const |
| Tries to find Resource URL for Resource ID from this node. | |
| template<typename DataType > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| uint32_t | getChangeFlags () const |
| Get current change flags. | |
| uint32_t | getChildChangeFlags () const |
| Get current child change flags. | |
| FocusManager * | getFocusManager () const |
| Returns the Focus Manager associated with the Screen node to which this node belongs. | |
| FocusScope * | getFocusScopeInfo () const |
| Returns the information about the focus scope for a node. | |
| InputManager * | getInputManager () const |
| Returns the Input Manager associated with the Screen node to which this node belongs. | |
| AbstractPropertyTypeDescriptor::ValueSource * | getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::DataType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| Node * | getParent () const |
| Returns the parent of the node. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. | |
| ResourceDictionarySharedPtr | getResourceDictionary () const |
| If a node has a resource dictionary, returns the resource dictionary of that node. | |
| Screen * | getScreen () const |
| Returns the Screen node to which this node belongs. | |
| NodeSharedPtr | getTemplateRoot () const |
| Gets the template root of this node. | |
| void | invalidateArrange () |
| Invalidates arrange. | |
| void | invalidateDraw () |
| Invalidates draw flag for the node. | |
| void | invalidateFinalTransform () |
| Invalidates final transform for node. | |
| void | invalidateMeasure () |
| Invalidates measure for the node. | |
| void | invalidateRender () |
| Invalidates render for node. | |
| bool | isAnyChangeFlagSet (uint32_t flag) const |
| Checks if any of given flags is set. | |
| bool | isAnyChildChangeFlagSet (uint32_t flag) const |
| Checks if any child change flags (corresponding to given mask) are set. | |
| bool | isAttached () const |
| Returns true if the node is attached to a screen or one of its descendants. | |
| bool | isAttaching () const |
| Returns true if node is in the process of attaching, false otherwise. | |
| bool | isChangeFlagSet (uint32_t flag) const |
| Checks if a change flag is set. | |
| bool | isChildChangeFlagSet (uint32_t flag) const |
| Checks if child change flags match. | |
| bool | isDetaching () const |
| Returns true if the node currently detaching. | |
| bool | isEffectivelyFocusable () const |
| Returns whether a node is focusable. | |
| bool | isEffectivelyVisible () const |
| Returns whether a node and its ancestor nodes are visible. | |
| bool | isInitialized () const |
| Returns true if initialize() has been called, false otherwise. | |
| bool | isInvalidArrange () const |
| Checks if the node needs arrange. | |
| bool | isInvalidDraw () |
| Tells if node draw flag is invalid. | |
| bool | isInvalidFinalTransform () const |
| Tells if final transform flag is invalid for node. | |
| bool | isInvalidMeasure () const |
| Check if the node needs measure. | |
| bool | isInvalidRender () const |
| Returns if node render flag is invalid. | |
| bool | isNamed (string_view name) const |
| KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty) | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNode (string_view pathOrKey) |
| Returns a node of specified type by looking it up with specified path or alias. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNodeComponent (string_view name) |
| Returns a node component of specified type by looking it up with specified name. | |
| Node * | lookupNodeRaw (string_view relativePath) |
| Get an object node by another node and a relative path. | |
| ObjectSharedPtr | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| tuple< NodeSharedPtr, AbstractPropertyType > | lookupObjectForStateManager (string_view relativePath) |
| Lookup for an node and possible object from within the node for state manager. | |
| void | notifyResourceDictionaryModified () |
| Forces the re-evaluation of resource IDs in a node tree. | |
| void | removeAnonymousResource (const Resource &resource) |
| Removes anonymous resource from object node resources. | |
| void | removeInputManipulator (InputManipulator &inputManipulator) |
| Removes the ownership and detaches an input manipulator from an object node. | |
| void | removeKZBData () |
| Destroys all object node data loaded from KZB. | |
| void | removeKZBData (flat_set< AbstractPropertyType > *keepProperties) |
| Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. | |
| void | removeMessageHandler (MessageSubscriptionToken token) |
| Removes a message subscription. | |
| void | removeNodeComponent (NodeComponent &nodeComponent) |
| Removes the ownership of a node component from an object node. | |
| void | removeNodeComponentWithOwner (const void *owner) |
| Removes all bindings with the specified owner. | |
| void | removeNodeReference (const AbstractNodeReference &reference) |
| void | removeResource (const ResourceID &resourceId) |
| Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. | |
| void | removeResourceReference (const AbstractResourceReference &reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| void | setChangeFlag (uint32_t flag) |
| Sets a change flag. | |
| void | setChildChangeFlag (uint32_t flag) |
| Sets a child change flag. | |
| void | setParent (Node *parent) |
| Kanzi uses this method internally to set the parent of a node. | |
| void | setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Replaces the resource dictionary of a node. | |
| void | setScreen (Screen *screen) |
| Sets the Screen node to which this node belongs. | |
| void | setTemplateRoot (NodeSharedPtr templateRoot) |
| Sets the template root of this node. | |
| ResourceSharedPtr | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. | |
| KZ_DEPRECATED NodeSharedPtr | trySetActiveFocus () |
| Tries to move the focus on this node. | |
| NodeSharedPtr | trySetFocus () |
| Tries to move the focus to this node. | |
| NodeSharedPtr | trySetFocus (FocusFallback fallbackOption) |
| Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. | |
| void | unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| Unapplies a style from an object node. | |
| void | unapplyStyles () |
| Unapplies and removes all applied styles. | |
| void | unapplyStylesRecursive () |
| Unapplies styles recursively. | |
| void | validateArrange () |
| Validates arrange. | |
| void | validateDraw () |
| Validates draw flags for the node. | |
| void | validateDrawForChildrenRecursive () |
| Recursively validates draw for the children from this 2D node onwards. | |
| void | validateMeasure () |
| Validates measure for the node. | |
| void | validateRender () |
| Validates render for node. | |
| VisitorResult | visit (const Visitor &visitor, VisitorOrder order) |
| Visits a node and its descendants. | |
| VisitorResult | visitDescendants (const Visitor &visitor, VisitorOrder order) |
| Visits the descendants of a node. | |
| ~Node () override | |
| Destructor. | |
| string | getName () const |
| Gets the value of NameProperty. | |
| void | setName (string_view value) |
| Sets the value of NameProperty. | |
| string | getPath () const |
| Gets the value of PathProperty. | |
| void | setPath (string value) |
| Sets the value of PathProperty. | |
| string | getLocale () const |
| Gets the value of LocaleProperty. | |
| void | setLocale (string value) |
| Sets the value of LocaleProperty. | |
| bool | isHitTestable () const |
| Gets the value of HitTestableProperty. | |
| void | setHitTestable (bool value) |
| Sets the value of HitTestableProperty. | |
| bool | isHitTestableContainer () const |
| Gets the value of HitTestableContainerProperty. | |
| void | setHitTestableContainer (bool value) |
| Sets the value of HitTestableContainerProperty. | |
| bool | isVisible () const |
| Gets the value of VisibleProperty. | |
| void | setVisible (bool value) |
| Sets the value of VisibleProperty. | |
| bool | isEnabled () const |
| Returns the value of the EnabledProperty. | |
| void | setEnabled (bool value) |
| Sets the value of the EnabledProperty. | |
| bool | isEffectivelyEnabled () const |
| Returns the value of EffectivelyEnabledProperty. | |
| bool | isFocusable () const |
| Gets the value of the FocusableProperty. | |
| void | setFocusable (bool value) |
| Sets the value of the FocusableProperty. | |
| bool | isFocused () const |
| Gets the value of the FocusedProperty. | |
| void | setFocused (bool value) |
| Sets the value of the FocusedProperty. | |
| FocusState | getFocusState () const |
| Gets the value of the FocusStateProperty. | |
| void | setFocusState (FocusState state) |
| Sets the value of the FocusStateProperty. | |
| FontFamilySharedPtr | getFontFamily () const |
| Gets the font family the node uses. | |
| void | setFontFamily (FontFamilySharedPtr value) |
| Sets the font family the node uses. | |
| float | getVisibleAmountInParent () const |
| Gets the value of VisibleAmountInParentProperty. | |
| void | setVisibleAmountInParent (float value) |
| Sets the value of VisibleAmountInParentProperty. | |
| float | getProjection2DTo3DScale () const |
| Gets the value of Projection2DTo3DScaleProperty. | |
| void | setProjection2DTo3DScale (float value) |
| Sets the value of Projection2DTo3DScaleProperty. | |
| ResourceSharedPtr | getStyle () const |
| Gets the value of StyleProperty. | |
| void | setStyle (ResourceSharedPtr value) |
| Sets the value of StyleProperty. | |
| ResourceSharedPtr | getStateManager () const |
| Gets the value of StateManagerProperty. | |
| void | setStateManager (ResourceSharedPtr value) |
| Sets the value of StateManagerProperty. | |
| float | getWidth () const |
| Gets the value of WidthProperty. | |
| void | setWidth (float value) |
| Sets the value of WidthProperty. | |
| float | getHeight () const |
| Gets the value of HeightProperty. | |
| void | setHeight (float value) |
| Sets the value of HeightProperty. | |
| float | getDepth () const |
| Gets the value of DepthProperty. | |
| void | setDepth (float value) |
| Sets the value of DepthProperty. | |
| float | getActualWidth () const |
| Gets the value of ActualWidthProperty. | |
| void | setActualWidth (float value) |
| Sets the value of ActualWidthProperty. | |
| float | getActualHeight () const |
| Gets the value of ActualHeightProperty. | |
| void | setActualHeight (float value) |
| Sets the value of ActualHeightProperty. | |
| float | getActualDepth () const |
| Gets the value of ActualDepthProperty. | |
| void | setActualDepth (float value) |
| Sets the value of ActualDepthProperty. | |
| Node::HorizontalAlignment | getHorizontalAlignment () const |
| Gets the value of HorizontalAlignmentProperty. | |
| void | setHorizontalAlignment (Node::HorizontalAlignment value) |
| Sets the value of HorizontalAlignmentProperty. | |
| Node::VerticalAlignment | getVerticalAlignment () const |
| Gets the value of VerticalAlignmentProperty. | |
| void | setVerticalAlignment (Node::VerticalAlignment value) |
| Sets the value of VerticalAlignmentProperty. | |
| Node::DepthAlignment | getDepthAlignment () const |
| Gets the value of DepthAlignmentProperty. | |
| void | setDepthAlignment (Node::DepthAlignment value) |
| Sets the value of DepthAlignmentProperty. | |
| Vector2 | getHorizontalMargin () const |
| Gets the value of HorizontalMarginProperty. | |
| void | setHorizontalMargin (Vector2 value) |
| Sets the value of HorizontalMarginProperty. | |
| Vector2 | getVerticalMargin () const |
| Gets the value of VerticalMarginProperty. | |
| void | setVerticalMargin (Vector2 value) |
| Sets the value of VerticalMarginProperty. | |
| Vector2 | getDepthMargin () const |
| Gets the value of DepthMarginProperty. | |
| void | setDepthMargin (Vector2 value) |
| Sets the value of DepthMarginProperty. | |
| Node::ContentStretch | getContentStretch () const |
| Gets the value of ContentStretchProperty. | |
| void | setContentStretch (Node::ContentStretch value) |
| Sets the value of ContentStretchProperty. | |
| float | getOpacity () const |
| Gets the value of OpacityProperty. | |
| void | setOpacity (float value) |
| Sets the value of OpacityProperty. | |
| bool | isHover () const |
| Returns whether the node has HoverProperty set to true. | |
| bool | isClipChildren () const |
| Gets the value of ClipChildrenProperty. | |
| void | setClipChildren (bool value) |
| Sets the value of ClipChildrenProperty. | |
| Public Member Functions inherited from kanzi::Object | |
| AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. | |
| void | applyObjectStyles () |
| Apply all styles for an object node. | |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. | |
| const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object. | |
| MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain. | |
| detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. | |
| ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object. | |
| Object (Domain *domain) | |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object. | |
| void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. | |
| ~Object () override | |
| Public Member Functions inherited from kanzi::MetaObject | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. | |
| virtual | ~MetaObject () |
| Public Member Functions inherited from kanzi::PropertyObject | |
| template<typename DataType > | |
| void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers. | |
| template<typename DataType > | |
| void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container. | |
| void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object. | |
| void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object. | |
| PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers. | |
| template<typename DataType > | |
| size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type. | |
| bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. | |
| bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. | |
| bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
| PropertyObject () | |
| void | removeKzbProperties () |
| Remove all KZB properties. | |
| void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set. | |
| template<typename DataType > | |
| void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. | |
| template<typename DataType > | |
| void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| template<typename DataType > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type. | |
| void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| virtual | ~PropertyObject () |
| Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node > | |
| void | addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner) |
| Adds an already-created binding runtime to this binding host. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Sets a binding to a certain property. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Sets a modifier binding. | |
| Public Member Functions inherited from kanzi::BindingHostConcept | |
| BindingRuntimeConstIterator | beginBindingRuntimes () const |
| Returns an iterator to the beginning of binding runtimes. | |
| BindingRuntimeConstIterator | endBindingRuntimes () const |
| Returns an iterator to the end of binding runtimes. | |
| AbstractBindingRuntimeSharedPtr | getBindingRuntime (size_t idx) |
| Gets binding by index. | |
| size_t | getBindingRuntimeCount () const |
| Gets the number of binding runtimes added to this node. | |
| void | removeAllBindings () |
| Removes all binding runtimes. | |
| void | removeBinding (BindingRuntimeHandle &bindingRuntime) |
| Removes a binding runtime added earlier. | |
| void | removeBindingsWithOwner (shared_ptr< void > owner) |
| Removes all binding runtimes with the specified owner. | |
Static Public Member Functions | |
| static bool | isUnboundedLayoutSize (Vector2 layoutSize) |
| Returns whether a layout size is an unbound layout size. | |
| static bool | isValidLayoutSize (Vector2 size) |
| Returns whether a size is a valid layout size. | |
| static float | layoutUp () |
| Returns the direction to which the y axis grows for this node type. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static Vector2 | replaceUnboundedLayoutSize (Vector2 layoutSize, Vector2 resetSize) |
| Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. | |
| static Vector2 | replaceUnboundedLayoutSizeWithZero (Vector2 layoutSize) |
| Replaces any element of a layout size with zero if it is unbounded and returns the size. | |
| static Vector2 | unboundedLayoutSize () |
| Returns an unbound layout size. | |
| Static Public Member Functions inherited from kanzi::Node | |
| static bool | isUnboundedLayoutValue (float layoutValue) |
| Indicates whether a value is an unbound layout value. | |
| static bool | isValidLayoutValue (float value) |
| Indicates whether a value is valid layout value. | |
| static float | replaceUnboundedLayoutValue (float layoutValue, float resetValue) |
| Replaces layout value with the specified value if it is unbounded and returns it. | |
| static float | replaceUnboundedLayoutValueWithZero (float layoutValue) |
| Replaces layout value with zero if it is unbounded layout value and returns it. | |
| static float | unboundedLayoutValue () |
| Returns an unbounded layout value. | |
| Static Public Member Functions inherited from kanzi::Object | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
| Static Public Member Functions inherited from kanzi::MetaObject | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
Protected Types | |
| enum | Node2DFlags { AllowClear , AllowRenderChildren , AllowRenderSelf , ForegroundIsTranslucent , ForegroundTranslucencyRequested , RequiresBackgroundQuad , RequiresLocalTransformationScope , RequiresTilingUpdate , Node2DFlagsBitCount } |
| Different Node2D flags for bit set. More... | |
| Protected Types inherited from kanzi::Object | |
| typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
| Applied style container. | |
Protected Attributes | |
| QuadDescription | m_backgroundQuadDescription |
| Background clipping quad / composition quad description. | |
| NodeEffect2DSharedPtr | m_cachedEffect |
| Cached effect instance. | |
| ClippingArea | m_clipping |
| Clipping parameters. | |
| CompositionRequirements | m_compositionRequirements |
| Composition requirements for this 2D node. | |
| unique_ptr< NodeCompositor2D > | m_compositor |
| Composition and caching information. | |
| NodeEffectPrefab2DSharedPtr | m_currentEffectPrefab |
| Currently instantiated effect prefab. | |
| optional< QuadDescription > | m_effectQuadDescription |
| Effect quad description. | |
| unsigned int | m_validatedEffectPaddingChangeCounter |
| Effect padding change counter value at which effect quad was last validated. | |
| unique_ptr< NodeVisual2D > | m_visual |
| Visual information. | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. | |
| Protected Attributes inherited from kanzi::BindingHostConcept | |
| BindingRuntimeContainer | m_bindingRuntimes |
| Bindings in this object. | |
Friends | |
| void | doListBoxArrange (Node2D &node) |
| class | Screen |
| class | Viewport3D |
Detailed Description
Node2D is the base class of 2D nodes.
Node2D implements functionality common to all 2D nodes, such as rendering, layouting, and hit testing.
To create UI graphs, use classes derived from Node2D, such as Image2D, EmptyNode2D, and StackLayout2D. To implement your own custom rendering and layout, derive from Node2D.
You can use methods of the Node2D class to configure common parameters for rendering and layout. Use methods of the derived classes to control behavior specific to them.
Creating nodes
To create a 2D node, call a create function that returns a shared pointer to the node.
To create an EmptyNode2D node:
To create an Image2D node:
Each node has its own type of create function.
The constructors of nodes are protected, and can be accessed only by the inheriting classes. Node initialization happens within the create function, after constructing the node.
Node tree
Kanzi arranges nodes in a tree that you can think of as a directed acyclic graph with no loops. Each node can have multiple children but only one parent.
The root node of the node tree is always a 2D node. The root node does not have a parent, and it is usually of type Screen.
The Viewport2D node serves as a window to a 3D scene graph that Kanzi displays in the viewport area. A Viewport2D node must have a child Scene node as the root of the 3D scene graph. The child nodes of the Scene node are Node3D nodes.
Constructing the node tree
You can manipulate the node tree by adding children to nodes:
You can remove children from a parent node:
Parents take ownership, and hold a reference to the children.
Iterating the node tree
You can explore the node tree from a node by iterating its children:
You can also go upwards to the parent:
The parent returned is valid except for the root node that has no parent (it returns nullptr).
Finding nodes
Finding nodes in the node tree is inherited from Node base class. You can look for nodes with a path:
The paths work relative from the node doing the lookup. You can also traverse upwards:
If lookup fails, no node is returned. See node tree lookup in Node documentation.
Rendering
Kanzi renders nodes starting from the root node of the node tree, iterating the tree in depth-first algorithm.
A 2D node has a foreground and a background. Kanzi renders the foreground and background separately. Node classes can override the foreground or background rendering separately.
Foreground is the content of the node. For example, an image.
Background is the full node area. The background can be of the same size as the node content, or larger.
To fit the content to the node area, use the ContentStretchProperty.
Rendering order
Kanzi renders nodes in the order in which you add the nodes to the parent node. The node that you add first is rendered first.
You can modify the rendering order by reordering the child nodes within a parent node.
To render a node last, move that node to the front:
To render a node first, move that node to the back:
Kanzi always renders the content of a parent node before rendering its child nodes.
Using brushes
Kanzi uses brushes to render the foreground, background, and the optional composition of a node. Brushes determine how Kanzi does the rendering. A brush can display a color or an image, tint content provided by the node, or use an arbitrary shader to render the content of a node.
A 2D node can have a foreground brush, background brush, and a composition brush. Use the ForegroundBrushProperty, BackgroundBrushProperty, and CompositionBrushProperty to access the brushes.
To set the foreground brush of a 2D node:
Use the foreground brush to render the content that the node provides. For example, an Image2D node provides an image. If a node does not provide foreground content, setting the foreground brush has no effect. Most 2D nodes render on top of the background an empty foreground of the same size as the background. For example, the EmptyNode2D node.
To set the background brush of a 2D node:
Use the background brush to render the content outside and behind the node foreground area. If the node has no foreground or the foreground is translucent, the background fills the entire node area. If the foreground is opaque and fills the entire node area, Kanzi does not render the background.
To disable rendering, set null brush:
Note that some node types have default brushes, which is why removing the brush property is not enough to disable rendering. Instead, Kanzi renders the node using the default brush.
Opacity
To control the translucency of a node, use the OpacityProperty. You can set the opacity of a node:
Opacity affects node background, foreground, and all node children.
When the brushes or content of a 2D node are translucent, the foreground and background of that node can be translucent even when you do not set the OpacityProperty.
Setting a 2D node as translucent affects all children of that node. To render overlapping translucency in the child nodes correctly, it is possible that you have to composite the parent node. See Composition.
Render transformation
To set the rendering position of a node relative to its parent, use the RenderTransformationProperty:
Kanzi specifies the render transformation as SRT, that is, Scale, Rotation, and Translation.
By default, Kanzi performs the render transformation of a 2D node relative to the top-left corner of that node. To set the origin of the render transformation within the node, use the RenderTransformationOriginProperty:
You can also set the render transformation origin outside the node:
The values set to render transform origin are relative to the size of the node. For example, the value 0.5 ; 0.5 sets the origin at the center of the node.
Kanzi applies the render transformation after applying layout transformation. Render transformation is not affected by layout constraints such as alignment and margins, and does not modify the size layout nodes take into account. See Layout transformation.
Perspective transformation
To bring limited 3D effects to a 2D node tree, you can apply perspective transformation in 3D space. Perspective transformation is an optional transformation that Kanzi applies as the last Node2D transformation, after the layout and render transformations.
To set the perspective transformation:
Kanzi applies the projection for perspective transformation in the space of the current composition space. Kanzi specifies the perspective transformation as 3D SRT, that is, 3-component Scale, Rotation, and Translation vectors.
NodeVisual2D
Kanzi stores in an object of type NodeVisual2D all information related to the foreground and background rendering in Node2D. NodeVisual2D holds the brush and geometry information that Kanzi needs to render 2D node. To save memory, if node has nothing to render, Kanzi does not allocate a visual component.
Once the visual component is allocated, Node2D never releases it.
Composition
By default, Kanzi renders a 2D node into the rendering context of the parent node. Usually, the top-level rendering context is the backbuffer, provided by the Screen node.
You can manually override this and render a node into a render target:
When you specify the render target, the node takes its size from the render target size. You can define fixed width and fixed height for a node that also has a render target set. The fixed size can be smaller than the size of the render target. In this case, rendering happens only on a part of the render target area. Specifying a fixed size larger than the render target size is undefined behavior. A node that Kanzi renders into a render target also draws the resulting composition to the rendering context of their parent.
To achieve the correct rendering result, in some cases, Kanzi automatically renders nodes using a render target.
If the opacity of a Viewport2D is not 1.0 or if its transformation has non-translation components, that Viewport2D renders to a render target:
Viewport2D is a 'window' to a 3D scene. It must be aligned to the units in the parent render context. If this is not the case, it needs to be composited.
All nodes render to render targets if they have children and their opacity is not one:
The parent has opacity set, so it will first need to do composition of all its children, and then render this composition using that opacity.
When you assign a render target manually, you can set that render target to take its size from the size of the node. In this case, Kanzi resizes the composition target to the size that the node gets during layout:
Offscreen rendering
Nodes do not necessarily have to draw their composition onto the render context of their parent. To enable offscreen rendering:
When you enable offscreen rendering, Kanzi does not draw the node anywhere after rendering to its render target.
You can render the render target of the node using some other node:
The render target behaves like a normal texture when used. Setting the render target to an Image2D determines its size unless you set the render target to use fixed size.
Clearing a render target
When Kanzi renders a Node2D to a render target, it clears the color and depth buffers of that render target. If the render target has a depth buffer, and the node is not a Viewport2D that clears it in a RenderPass, Kanzi clears the depth buffer. If the foreground of the node does not fill the complete composition area, or the combination of background and foreground is translucent, Kanzi clears the color buffer.
To disable the clearing of a render target:
When you disable the clearing of a render target, you prevent the node from clearing the render target even if the node would otherwise do it.
By default, Kanzi clears all render targets. This simplifies the rendering code and increases performance on GPUs that use tiled renderers.
Caching
To avoid rendering a 2D node and its descendants every frame, you can cache the rendering results of a 2D node. Caching carries a cost in GPU memory. Cache only complex nodes that are expensive to render and change rarely. You can either:
- Let Kanzi update the cache automatically whenever the node or any of its descendants change.
- Make Kanzi use the same cache until you manually invalidate that cache.
To control the caching of a 2D node, use the CachingModeProperty. You can enable or disable the cache:
When the CachingModeProperty is set to CachingModeEnabled, the node content does not change until you either:
- Set the CachingModeProperty to CachingModeDisabled.
- Invalidate the cache.
To invalidate the cache:
After you invalidate the cache, Kanzi renders the node content once. After this, Kanzi considers the node cached again. You can disable the cache:
After you disable the cache, Kanzi renders the node normally and all changes to the node and its descendants are visible immediately.
Setting the CachingModeProperty to CachingModeAutomatic causes Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change. To set Kanzi to automatically update the cache:
When the caching mode is set to automatic, any change to the node or its descendants causes Kanzi to update the cache. You can manually set the draw flag on a child node to invalidate the cache:
Setting any property that controls rendering will eventually invalidate draw.
NodeCompositor2D
Kanzi stores in NodeCompositor2D all information related to compositing. This object holds composition targets, caching information, and a composition brush. Because compositing implies rendering, it is not possible to allocate a compositor without also allocating a NodeVisual2D. To save memory, if composition is not needed, Kanzi does not allocate a compositor component.
Once the compositor component is allocated, Node2D never releases it. Composition targets within compositor can be released if not needed.
Basic Layout
A 2D node tries to determine its size automatically. A 2D node with content by default takes the size of its content. For example, Image2D takes the size of the image that it displays. EmptyNode2D and Viewport2D have unbounded layout by default. This means that they take the entire available size. Kanzi calculates the available size from the size of the parent node, or the available screen area. To arrange nodes in a layout, use layout control nodes such as StackLayout2D or GridLayout2D.
To set the size of a 2D node:
To set a 2D node to determine its size automatically, remove the fixed size:
or:
You can configure a node to take its width or height based on a specified fixed size and an aspect ratio:
If fixed width and aspect ratio are defined, height is width divided by aspect ratio. If fixed height and aspect ratio are defined, width is height multiplied by aspect ratio. If both fixed width and fixed height are defined, aspect ratio has no effect.
If neither width or height are defined, but aspect ratio is defined, the result depends on the node. A node that has unbounded layout takes the largest size it can with the given aspect ratio while still fitting within its allocated size. Aspect ratio has no effect when the content of a node defines its size. This is analogous to having both fixed width and fixed height.
A 2D node has an allocated area specified by the area of the parent node or a layout node. You can configure a 2D node to align in its allocated area by setting horizontal and vertical alignment:
Available values for horizontal alignment are:
- HorizontalAlignmentLeft
- HorizontalAlignmentRight
- HorizontalAlignmentCenter
- HorizontalAlignmentStretch
Available values for vertical alignment are:
You can configure 2D node to fill its allocated area by setting alignment to stretch:
You can offset a 2D node from the edges of its parent node:
For horizontal margins, the order of values is left, then right. For vertical margins, the order of values is top, then bottom. Kanzi offsets the node from the edge of its allocated area by the amount equal to the margin that you set. When you do not set the margins, Kanzi aligns the node at the edge of allocated area.
Layout transformation
To set the transformation of a node relative to its parent node, set the LayoutTransformationProperty:
Kanzi specifies the layout transform as SRT, that is, Scale, Rotation, and Translation.
When you transform a node with layout transformation, Kanzi applies alignment and margins to that node after the transformation. Kanzi applies render transformation after layout transformation, alignment, and margins.
See Render transformation and Perspective transformation.
Content stretch
The foreground content, such as an image, of a 2D node, has rules on how to stretch in relation to the node area.
These are the available content stretch modes:
ContentStretchNone centers the foreground area in the node area and keeps the exact size of the content.
If the node is smaller than the foreground area, it displays only a part of the content.
If the node is larger than the foreground area, the remaining area is left for background rendering.
ContentStretchFill sets the foreground area to take the exact node area.
This can change the aspect ratio of the content.
ContentStretchUniform sets the foreground content to stretch to fill the node area while keeping its aspect ratio.
If the aspect ratio of the node is different from content aspect ratio, the remaining area is left for background rendering.
This is the default content stretch mode.
ContentStretchUniformToFill centers the foreground area relative to the node area and scales the foreground uniformly to fill the node area.
If the aspect ratio of the node is different from the content aspect ratio, the node displays only part of the content.
To set the content stretch mode:
Layout in main loop
During the main loop of the application, Kanzi calls layout for the root node. Before calling layout, Kanzi sets the allocated size of the Screen node to the size of the current graphics output. The layout pass evaluates only nodes that are marked as requiring layout. Kanzi calls render immediately after layout.
Because Kanzi calls render immediately after layout, you can modify the node tree and see the changes before the next call to the update function. It can be useful to determine the calculated sizes or locations of nodes before waiting for the next frame. To call layout manually:
After calling layout(), you can call getActualSize() to get the size determined by the node. Default allocated size is unbounded layout or infinity. When calling layout() manually, you must set the allocated size for the node that receives the layout() call.
See Implementing a custom 2D node - Layout.
Hit testing
You can hit test nodes in regard to their location on screen:
Hit testing uses the 'world' or 'render' coordinates of the node. These coordinates are relative to the screen, not to the parent node or to the node that does the hit testing. Hit testing takes into account the visibility and all transformations of a node.
Hit testing transforms global coordinates into Node2D local coordinates to determine if the node is hit. You can determine world (screen) space coordinates in the local coordinate space of a 2D node:
The return value is enclosed in an optional value, but is always valid if the node has a real nondegenerate transformation.
You can test whether given coordinates hit a node:
Checking whether a global coordinate is within a node is equal to calling globalToLocal() and then testing the result with containsLocal().
Implementing a custom 2D node
To do custom rendering and layout, you can implement a custom 2D node.
Defining the class
To define a custom Node2D implementation, inherit from the Node2D base class.
To define a Node2D implementation:
The next sections explain different parts of the node declaration.
Metaclass
Each class derived from Node2D must have a metaclass definition. To declare the metaclass, inherit from the Node2D base class and list the properties specific to the inherited node:
For details about metaclass, see the description in Node documentation.
Property types
Local property types are declared in metaclass to belong to the node. Additionally, property types must be declared within the node:
It is also often useful to declare setters and getters to wrap getProperty() and setProperty() for the custom property.
After declaring a property type in the class, you must add the property definition. The definition lists property metadata. The example property is defined as follows:
Note that the property has the PropertyTypeChangeFlagFinalTransformation flag set. This means that updateRender must be called for the node when the property value changes.
These property change flags determine what Kanzi has to recalculate when the property value changes.
PropertyTypeChangeFlagMeasure means that the node has to be measured.
This causes measure and arrange to propagate from the node.
Kanzi runs measure() to the node and potentially all of its ancestors if measured size changed.
Then, Kanzi runs arrange() and updateRender() to the node, all of the changed nodes, and their descendants.
PropertyTypeChangeFlagArrange means that the node has to be arranged.
This causes arrange to propagate from the node.
Kanzi runs arrange() and updateRender() to the node and all of its children.
PropertyTypeChangeFlagRender means that the rendering parameters of the node changed and have to be updated.
Kanzi runs updateRender() to the node. If the transformation or composition status of the node changed, Kanzi runs updateRender() to all children of the node.
Updating the transformation of the node is a phase in updateRender(). If the transformation has not changed, Kanzi does not run this phase. Measure and arrange imply that the transform changed.
PropertyTypeChangeFlagFinalTransformation means that the transformation of the node and its children have to be updated.
Kanzi runs updateRender() to the node and its children.
Nodes can have class values for properties:
A class value overrides the default value that the node otherwise has for a property, but the value applies only to objects of a certain class.
For more information about properties in nodes, see the documentation of the Node class.
Message types
To communicate with each other, Kanzi nodes send messages.
Declare the message types in the node:
Like the node itself, the message class must define a metaclass and properties.
You must also define the message type, metadata, and related property metadata:
The argument definition is similar to property type definition. You also need to define the message type and metadata for Kanzi Studio.
A node can subscribe to listen to any messages. Typically this happens on initialization.
For more information about messages, see the documentation of the Node class.
Initialize pattern
Constructing a node initializes node-specific values and passes them to the base class constructor.
Class values are initialized in the constructor.
Further initialization is done in Node::initialize(), that is called from the create function:
In this example, the node subscribes to listen a message defined earlier upon initialize:
For details of initialization, see the documentation of the Node class.
Attach and detach
When a node becomes a part of the node tree, it is attached. When a node is no longer a part of the node tree, it is detached. Nodes can also be attached or detached if their parent is attached or detached. This typically happens when the parent is added or removed from the node tree.
Attaching connects and activates node features related to its location in the node tree. This includes resource references, bindings, triggers, input manipulators, and so on.
For details on attach and detach, see the documentation of the Node class.
Rendering
Custom node rendering is controlled by overriding rendering functions and setting the render type. During the render process, nodes first call their rendering functions, then rendering descends to the children.
Rendering functions
To override the rendering of the foreground, implement renderForegroundOverride(). The default implementation of renderForegroundOverride() is empty, because all nodes decide on their own rendering.
To override the rendering of both the foreground and background, implement renderSelfOverride(). The default implementation of renderSelfOverride() applies the composition stack, and then defers to background and foreground rendering. When implementing this function, remember to ensure that the viewport settings are correct before you issue draw calls.
To use normal background rendering within overridden rendering, call renderBackground(). renderBackground() checks whether a background brush exists, and then renders the background quad. In the case of opaque foreground, background rendering renders a 'frame' around the node content area, if possible.
When you want to override the entire rendering process of a 2D node, implement renderOverride(). This can be necessary in some rare cases. For example, implement renderOverride() when you want to alter the way caching or the allocation of composition targets works.
For most nodes, implementing renderSelfOverride() is enough.
Render type
Node2D rendering is controlled by RenderType. Set it upon constructor or node initialization to reflect on node rendering behavior. RenderType acts as a hint to the rendering system, regarding how to set viewport settings and how to handle background rendering.
- RenderTypeNone is for nodes that do not have foreground content to render. For example, EmptyNode2D.
- RenderTypeTexture is for nodes that render their foreground as a rectangular quad. For example, Image2D.
RenderTypeManual is for nodes that handle their own foreground rendering. For example, Viewport2D.
This implies that the system has to set up viewport coordinates for the area of the node. This pushes a local viewport area to the composition stack.
A node that uses RenderTypeManual needs to implement renderSelfOverride.
RenderTypeManualClipped is for nodes that handle their own foreground rendering, but do not need a local viewport area. For example, TextBlock2D.
This implies that nodes that use RenderTypeManualClipped either clip their own content, or you do not care about clipping.
A node that uses RenderTypeManualClipped needs to implement at least renderForegroundOverride, possibly renderSelfOverride.
Layout
A custom node follows the layout directives described in the Basic layout section. You can override the layout partially by implementing layout functions.
Measurement pass
In measure(), Kanzi determines the desired size of a node.
The measurement pass descends recursively downwards until it finds nodes that are flagged as needing measure. For every node whose size changed, measure ascends upwards to the root and flags the node as requiring arrange.
To override the size that Kanzi otherwise determines for the node, implement measureOverride():
The size returned by measureOverride() determines the desired size of the content. The desired size of the node is affected by the desired size of the content and the properties of the node.
Arrange pass
In arrange(), Kanzi determines the actual size and transformation of the node.
The arrange pass descends recursively downwards to nodes that are flagged as needing arrange, and then arranges those nodes and their children.
The arrange process:
- Reads the available size for the node.
- Determines the transformation and actual size of the node based on the properties of the node.
Nodes that perform layout on their child nodes must implement arrangeOverride(). During the arrange pass of the parent node, Kanzi already finished measuring the children nodes. Arranging children works by iterating over child nodes and setting their allocated sizes and arrange transformations. For non-layout nodes, (default) arrangeOverride() sets the allocated size of the child nodes as the actual size of the node, and resets child arrange transformation.
Update render pass
In updateRender(), Kanzi determines the final transformation, brushes, and composition settings of a node.
Kanzi calls updateRender() after arrange for all nodes that are marked as requiring a transformation update.
A node can implement updateRenderOverride() to do custom clipping or modify brush or composition settings:
Member Typedef Documentation
◆ LayoutVectorType
◆ LayoutMatrixType
◆ ChildContainer
Container type for children.
◆ ChildConstIterator
| typedef ChildContainer::const_iterator kanzi::Node2D::ChildConstIterator |
Iterator type for children.
◆ ChildConstReverseIterator
| typedef ChildContainer::const_reverse_iterator kanzi::Node2D::ChildConstReverseIterator |
Reverse iterator type for children.
◆ HitTestVisitor
| typedef NodeSharedPtr(* kanzi::Node2D::HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData) |
Hit test visitor function.
Member Enumeration Documentation
◆ PixelFormat
◆ ForegroundHint
Hint for foreground handling of nodes.
| Enumerator | |
|---|---|
| ForegroundHintNone | No hint given, assumed the background of a node can be rendered after content. |
| ForegroundHintTranslucent | Some elements rendered within the node are translucent over the background. |
| ForegroundHintOpaque | Node content is assumed to be fully opaque, meaning that there is no need to render the background. |
◆ RenderType
Node2D render type - affects elementary decisions about node rendering.
| Enumerator | |
|---|---|
| RenderTypeNone | Node has no foreground content to render. |
| RenderTypeTexture | Node renders itself as a textured quad. |
| RenderTypeManual | Node handles its own rendering. |
| RenderTypeManualClipped | Node handles its own rendering, but also clips its own content. This means that the node does not need additional composition area definitions, and can be rendered directly. |
◆ PerspectiveTransformationMode
◆ Node2DFlags
|
protected |
Different Node2D flags for bit set.
| Enumerator | |
|---|---|
| AllowClear | Is clearing allowed? This flag is turned on by default, but can be disabled by node properties. 2D nodes only clear color buffers, even if other buffers are created. |
| AllowRenderChildren | Are children rendered for this node or are they handled in a special manner? |
| AllowRenderSelf | Is the node allowed to render itself? |
| ForegroundIsTranslucent | Does layout detected foreground translucency? |
| ForegroundTranslucencyRequested | Has an extra request been filed (by implementations) for foreground translucency?. |
| RequiresBackgroundQuad | Is background quad required. |
| RequiresLocalTransformationScope | Node requires local transformation scope. Set by specialized node classes that perform their own custom composition. |
| RequiresTilingUpdate | Node requires tiling update. Kanzi sets this when the value of a tiling property changes, and clears it after updating the node geometry.
|
| Node2DFlagsBitCount | Number of options. |
Constructor & Destructor Documentation
◆ ~Node2D()
|
override |
◆ Node2D()
|
explicitprotected |
Member Function Documentation
◆ layoutUp()
Returns the direction to which the y axis grows for this node type.
- Returns
- The direction of the y axis.
◆ isValidLayoutSize()
Returns whether a size is a valid layout size.
A size is valid if all its elements are valid layout values.
- Parameters
-
size The size for which to test whether it is a valid layout size.
- Returns
- If the size is a valid layout size, true, otherwise false.
- See also
- Node::isValidLayoutValue()
◆ unboundedLayoutSize()
Returns an unbound layout size.
- Returns
- Unbound layout size.
◆ isUnboundedLayoutSize()
Returns whether a layout size is an unbound layout size.
A size is a an unbound layout size if any of its elements is an unbounded layout value.
- Parameters
-
layoutSize The layout size for which to test whether it is unbound layout size.
- Returns
- If the layout size is an unbound layout size,true, otherwise false.
◆ replaceUnboundedLayoutSize()
|
inlinestatic |
Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size.
- Parameters
-
layoutSize Layout size to test if any of its elements is unbounded layout value. resetSize The size whose values are used as a replacement for specified layout size's unbounded value elements.
- Returns
- layoutSize with its unbounded value elements replaced with the elements of resetSize.
◆ replaceUnboundedLayoutSizeWithZero()
Replaces any element of a layout size with zero if it is unbounded and returns the size.
- Parameters
-
layoutSize Layout size to test if any of its elements is unbounded layout value.
- Returns
- layoutSize with its unbounded value elements replaced with zero.
◆ getAspectRatio()
|
inline |
Gets the value of AspectRatioProperty.
- See also
- setAspectRatio()
◆ setAspectRatio()
Sets the value of AspectRatioProperty.
- See also
- getAspectRatio()
◆ isForceComposition()
|
inline |
Gets the value of ForceCompositionProperty.
- See also
- setForceComposition()
◆ setForceComposition()
Sets the value of ForceCompositionProperty.
- See also
- isForceComposition()
◆ getForegroundHint()
|
inline |
Gets the value of ForegroundHintProperty.
- See also
- setForegroundHint()
◆ setForegroundHint()
|
inline |
Sets the value of ForegroundHintProperty.
- See also
- getForegroundHint()
◆ isOffscreenRendering()
|
inline |
Gets the value of OffscreenRenderingProperty.
- See also
- setOffscreenRendering()
◆ setOffscreenRendering()
Sets the value of OffscreenRenderingProperty.
- See also
- isOffscreenRendering()
◆ isDisableRenderTargetClear()
|
inline |
Gets the value of DisableRenderTargetClearProperty.
- See also
- setDisableRenderTargetClear()
◆ setDisableRenderTargetClear()
Sets the value of DisableRenderTargetClearProperty.
- See also
- isDisableRenderTargetClear()
◆ getPixelFormat()
|
inline |
Gets the value of PixelFormatProperty.
- See also
- setPixelFormat()
◆ setPixelFormat()
|
inline |
Sets the value of PixelFormatProperty.
- See also
- getPixelFormat()
◆ isRenderSelf()
|
inline |
Gets the value of RenderSelfProperty.
- See also
- setRenderSelf()
◆ setRenderSelf()
Sets the value of RenderSelfProperty.
- See also
- isRenderSelf()
◆ getRenderTargetMinimumHeight()
|
inline |
Gets the value of RenderTargetMinimumHeightProperty.
- See also
- setRenderTargetMinimumHeight()
◆ setRenderTargetMinimumHeight()
Sets the value of RenderTargetMinimumHeightProperty.
- See also
- getRenderTargetMinimumHeight()
◆ getRenderTargetMinimumWidth()
|
inline |
Gets the value of RenderTargetMinimumWidthProperty.
- See also
- setRenderTargetMinimumWidth()
◆ setRenderTargetMinimumWidth()
Sets the value of RenderTargetMinimumWidthProperty.
- See also
- getRenderTargetMinimumWidth()
◆ getRenderTargetReallocationLimit()
|
inline |
Gets the value of RenderTargetReallocationLimitProperty.
◆ setRenderTargetReallocationLimit()
Sets the value of RenderTargetReallocationLimitProperty.
◆ getCachingMode()
|
inline |
Gets the value of CachingModeProperty.
- See also
- setCachingMode()
- Returns
- Caching mode value.
- Since
- Kanzi 3.9.0
◆ setCachingMode()
|
inline |
Sets the value of CachingModeProperty.
- See also
- getCachingMode()
- Parameters
-
value New caching mode value.
- Since
- Kanzi 3.9.0
◆ getPerspectiveTransformation()
|
inline |
Gets the value of PerspectiveTransformationProperty.
- See also
- setPerspectiveTransformation()
◆ setPerspectiveTransformation()
|
inline |
Sets the value of PerspectiveTransformationProperty.
- See also
- getPerspectiveTransformation()
◆ getPerspectiveTransformationMode()
|
inline |
Gets the value of PerspectiveTransformationModeProperty.
◆ setPerspectiveTransformationMode()
|
inline |
Sets the value of PerspectiveTransformationModeProperty.
◆ getPerspectiveTransformationFov()
|
inline |
Gets the value of PerspectiveTransformationFovProperty.
◆ setPerspectiveTransformationFov()
Sets the value of PerspectiveTransformationProperty.
◆ getPerspectiveTransformationPivot()
|
inline |
Gets the value of PerspectiveTransformationPivotProperty.
◆ setPerspectiveTransformationPivot()
Sets the value of PerspectiveTransformationPivotProperty.
◆ getPerspectiveTransformationOrigin()
|
inline |
Gets the value of PerspectiveTransformationOriginProperty.
◆ setPerspectiveTransformationOrigin()
Sets the value of PerspectiveTransformationOriginProperty.
◆ getRenderTransformationOrigin()
|
inline |
Gets the value of RenderTransformationOriginProperty.
- See also
- setRenderTransformationOrigin()
◆ setRenderTransformationOrigin()
Sets the value of RenderTransformationOriginProperty.
- See also
- getRenderTransformationOrigin()
◆ isSnapToPixel()
|
inline |
Gets the value of SnapToPixelProperty.
- See also
- setSnapToPixel()
◆ setSnapToPixel()
Sets the value of SnapToPixelProperty.
- See also
- isSnapToPixel()
◆ getMultisampleLevel()
|
inline |
◆ setMultisampleLevel()
|
inline |
◆ makeEditorInfo()
|
static |
◆ beginChildren()
| ChildConstIterator kanzi::Node2D::beginChildren | ( | ) | const |
◆ endChildren()
| ChildConstIterator kanzi::Node2D::endChildren | ( | ) | const |
◆ rbeginChildren()
| ChildConstReverseIterator kanzi::Node2D::rbeginChildren | ( | ) | const |
◆ rendChildren()
| ChildConstReverseIterator kanzi::Node2D::rendChildren | ( | ) | const |
◆ addChild()
| void kanzi::Node2D::addChild | ( | Node2DSharedPtr | child | ) |
Adds a child node.
Adding a 3D node node as a child of a 2D node is only allowed when adding a scene to a viewport. Screens can have only one child which is a 2D node.
◆ insertChild()
| void kanzi::Node2D::insertChild | ( | size_t | index, |
| Node2DSharedPtr | child ) |
Adds a child node for object node to given index.
Adding a 3D node node as a child of a 2D node is only allowed when adding a scene to a viewport. Screens can have only one child which is a 2D node.
◆ removeChild() [1/2]
◆ removeChild() [2/2]
| void kanzi::Node2D::removeChild | ( | size_t | index | ) |
Removes child node at specified index.
◆ removeAllChildren()
| void kanzi::Node2D::removeAllChildren | ( | ) |
Removes all child nodes.
◆ getChild()
| Node2DSharedPtr kanzi::Node2D::getChild | ( | size_t | index | ) | const |
Returns a child from given index from object node.
◆ getChildIndex()
Returns the index of a child in an object node.
◆ hasChild()
Returns whether the given node is a child of this node.
- Parameters
-
child The node to check.
◆ getChildCount()
| size_t kanzi::Node2D::getChildCount | ( | ) | const |
Gets the number of children of the node.
◆ moveToBack()
| void kanzi::Node2D::moveToBack | ( | ) |
Repositions the node to the beginning of its parent's children, so that it is drawn first.
◆ moveToFront()
| void kanzi::Node2D::moveToFront | ( | ) |
Repositions the node to the end of its parent's children, so that it is drawn last.
◆ moveChildToPosition()
| void kanzi::Node2D::moveChildToPosition | ( | Node2DSharedPtr | child, |
| size_t | index ) |
Moves a child node to a given position in the list of child nodes.
- Parameters
-
child Child node to reposition. index Position at which to place the child node in the list of child nodes.
- Since
- Kanzi 3.9.3
◆ getRenderType()
|
inline |
Get render type.
- Returns
- Render type enumeration.
◆ getEffect()
|
inline |
Gets the value of EffectProperty.
- Since
- Kanzi 3.9.0
◆ getRenderableEffect()
|
inline |
Gets a pointer to the current effect if effect rendering is required.
- Returns
- If an effect is set and the effect is renderable, returns a pointer to the effect, otherwise nullptr.
◆ getEffectRenderer()
|
inline |
Gets the effect renderer.
The effect renderer is set only if the effect is both set and is renderable.
- Returns
- Pointer to effect renderer.
◆ hasEffect()
|
inline |
Whether an active effect is applied to this node.
- Returns
- If an active effect is applied, true, otherwise false.
- Since
- Kanzi 3.9.0
◆ getEffectPrefab()
|
inline |
Gets the value of EffectPrefabProperty.
- Since
- Kanzi 3.9.0
◆ setEffectPrefab()
|
inline |
Sets the value of EffectPrefabProperty.
- Since
- Kanzi 3.9.0
◆ getBackgroundBrush()
|
inline |
Gets value of BackgroundBrushProperty.
◆ setBackgroundBrush()
|
inline |
Sets value of BackgroundBrushProperty.
◆ getCompositionBrush()
|
inline |
Gets value of CompositionBrushProperty.
◆ setCompositionBrush()
|
inline |
Sets value of CompositionBrushProperty.
◆ getForegroundBrush()
|
inline |
Gets value of ForegroundBrushProperty.
◆ setForegroundBrush()
|
inline |
Sets value of ForegroundBrushProperty.
◆ getBackgroundBrushRenderer()
|
inline |
Get background brush renderer.
- Returns
- Pointer to background brush renderer.
◆ getForegroundBrushRenderer()
|
inline |
Get foreground brush renderer.
- Returns
- Pointer to foreground brush renderer.
◆ getCompositionBrushRenderer()
|
inline |
Access cache result brush renderer.
- Returns
- Pointer to brush renderer.
◆ getRenderTransformation()
|
inline |
Gets the value of RenderTransformationProperty.
- See also
- setRenderTransformation()
◆ setRenderTransformation()
|
inline |
Sets the value of RenderTransformationProperty.
- See also
- getRenderTransformation()
◆ render() [1/2]
| void kanzi::Node2D::render | ( | Renderer3D & | renderer, |
| CompositionStack & | compositionStack, | ||
| const optional< Matrix3x3 > & | baseTransform ) |
Renders a node and its descendant nodes.
- Parameters
-
renderer Renderer to use. compositionStack Render context stack to use. baseTransform Optional transform in composition space.
◆ render() [2/2]
|
inline |
Render a node and its descendant nodes.
Omits the base transformation.
- Parameters
-
renderer Renderer to use. compositionStack Render context stack to use.
◆ getVisual()
|
inline |
Access visual component.
- Returns
- Pointer to visual component or NULL if it doesn't exist.
◆ getRenderTarget()
|
inline |
Gets value of RenderTargetProperty.
◆ setRenderTarget()
|
inline |
Sets value of RenderTargetProperty.
◆ getCompositionTarget()
|
inline |
Gets the composition target used for compositing the node.
The composition target can be set manually by you or created automatically by Kanzi.
- Returns
- Composition target for the node or nullptr.
◆ hasCompositionTarget()
|
inline |
Indicates whether the node has a composition target.
- Returns
- If the node has a composition target, true, otherwise false.
◆ getManagedCompositionTarget()
|
inline |
Gets the managed composition target of a node.
- Returns
- The managed composition target or nullptr.
◆ hasManagedCompositionTarget()
|
inline |
Returns whether the node has a managed composition target.
- Returns
- If the node has a managed composition target, true, otherwise false.
◆ isCacheValid()
|
inline |
Returns whether the children cache is valid.
- Returns
- If the cache is valid, true, otherwise false.
◆ resetCache()
|
inline |
Resets cached content for complete content of a node, including the node and its children.
Does not change the caching property. If caching is enabled, Kanzi recreates the cache on next render.
◆ getCompositionManager()
|
inline |
Access composition manager.
◆ getCompositor()
|
inline |
Accesses the compositor component.
- Returns
- Pointer to compositor component or, if the component does not exist, nullptr.
◆ setAutoWidth()
| void kanzi::Node2D::setAutoWidth | ( | ) |
Sets a node to determine its width automatically.
◆ setAutoHeight()
| void kanzi::Node2D::setAutoHeight | ( | ) |
Sets a node to determine its height automatically.
◆ setAutoSize()
| void kanzi::Node2D::setAutoSize | ( | ) |
Sets a node to determine its width and height automatically.
◆ setSize() [1/2]
Sets the size of a node.
- Parameters
-
width The width to set. height The height to set.
◆ setSize() [2/2]
Sets the size of a node.
- Parameters
-
size A vector that contains the width and height to set.
◆ setLayoutSize()
|
inline |
◆ getLayoutTransformation()
|
inline |
Gets the value of the LayoutTransformationProperty.
- See also
- setLayoutTransformation()
◆ setLayoutTransformation()
|
inline |
Sets the value of the LayoutTransformationProperty.
- See also
- getLayoutTransformation()
◆ getDesiredSize()
|
inline |
Gets the desired size of a node.
- Returns
- Size vector.
◆ setDesiredSize()
Sets the desired size of a node.
- Parameters
-
desiredSize A vector that contains the size to set.
◆ getAllocatedSize()
|
inline |
Gets the allocated size of a node.
- Returns
- Size vector.
◆ setAllocatedSize()
Sets the allocated size of a node.
If the allocated size differs from the existing allocated size, calling this function invalidates the arrange.
- Parameters
-
allocatedSize A vector that contains the size to set.
◆ getActualSize()
|
inline |
Gets the actual size of a node.
- Returns
- Size vector.
◆ setActualSize() [1/2]
Sets the actual size of a node.
- Parameters
-
actualSize A vector that contains the size to set.
◆ setActualSize() [2/2]
Sets the actual size of a node.
- Parameters
-
sizeX The x component of the size. sizeY The y component of the size.
◆ getArrangeTransform()
|
inline |
Gets the arrange transform.
- Returns
- Transformation matrix.
◆ setArrangeTransform()
Sets the arrange transform.
If the layout transform differs from the existing transform, calling this function invalidates the arrange.
- Parameters
-
transform Transformation matrix.
◆ layout() [1/2]
Does a layout pass starting from this node and iterating recursively all of its children.
Measure pass only descends up to nodes marked for requiring measure and then propagates upwards for all nodes that were changed. After measure, all nodes marked for requiring arrange and all their children are arranged.
The actual size of a node is not known before layout. You can call layout manually to determine the actual sizes of nodes. Before calling layout, the node must have allocated size set to limit node area to anything less than infinity. Normal layout process sets allocated size to current composition size.
- Parameters
-
rootTransform Transform applied to root node for arrange pass if set. Can be used to offset complete node tree, but should usually be empty.
◆ layout() [2/2]
|
inline |
◆ measure()
Measures one node.
- Parameters
-
availableSize Available size passed from parent, can be NULL. handleStretch Whether the node should handle stretching of node to fill available space.
- Returns
- If measure needs to be propagated, true, otherwise false.
◆ measureRecursive()
Performs measure recursively.
Reimplemented in kanzi::Viewport2D.
◆ arrange()
| void kanzi::Node2D::arrange | ( | ) |
Performs layout arrangement on a 2D node.
◆ transform()
|
inline |
Transforms a 2D node.
- Since
- 3.9.4
◆ getWorldTransform()
|
inline |
Gets the world transformation matrix.
- Returns
- Transformation matrix.
◆ containsLocal()
Returns whether a node area contains a point defined in the local space of the node.
- Returns
- If the node area contains the point, true, otherwise false.
◆ containsGlobal()
Checks whether a node area contains a point defined in screen space. If it does, writes the node-space coordinates into the outgoing point.
◆ globalToLocal()
◆ hitTest() [1/4]
| NodeSharedPtr kanzi::Node2D::hitTest | ( | Vector2 | point | ) |
Performs a hit test to a 2D node and all its child nodes.
Returns the topmost 2D node under given point.
- Parameters
-
point Point in world coordinates.
- Returns
- Node hit or an empty shared pointer.
◆ hitTest() [2/4]
| NodeSharedPtr kanzi::Node2D::hitTest | ( | Vector2 | point, |
| const Metaclass * | type ) |
◆ hitTestIterate()
| NodeSharedPtr kanzi::Node2D::hitTestIterate | ( | Vector2 | point, |
| HitTestVisitor | visitor, | ||
| void * | userData ) |
Hit tests nodes recursively from this node downwards and calls visitor function on the hit nodes.
Used for specific implementations of hit testing.
- Parameters
-
point Point in world coordinates. visitor Visitor function to call on nodes. userData User data passed to visitor function.
- Returns
- Node hit or an empty shared pointer.
◆ hitTestContent()
|
virtual |
Default implementation of Node2D content hit test.
Returns the node itself.
- Parameters
-
point Point in node space.
- Returns
- Tuple of found node, ray hitting that node and distance along the ray.
Reimplemented in kanzi::Viewport2D.
◆ hitTest() [3/4]
Wrapper for hitTest(Vector2), casts the return value.
- Parameters
-
point Point in world coordinates.
- Returns
- Typed node hit or an empty shared pointer.
◆ hitTest() [4/4]
Wrapper for hitTest(Vector2, const Metaclass), casts the return value.
- Parameters
-
point Point in world coordinates. type Metaclass type to limit hit testing to.
- Returns
- Typed node hit or an empty shared pointer.
◆ findAbstractChildOverride()
|
overridevirtual |
Node::findAbstractChildOverride() implementation.
Implements kanzi::Node.
Reimplemented in kanzi::Viewport2D.
◆ visitAbstractChildOverride()
|
overridevirtual |
Node::visitAbstractChild implementation.
Implements kanzi::Node.
Reimplemented in kanzi::Viewport2D.
◆ addAbstractChildOverride()
|
overridevirtual |
Node::addAbstractChildOverride() implementation.
Implements kanzi::Node.
◆ getAbstractChildCountOverride()
|
overridevirtual |
Node::getAbstractChildCountOverride() implementation.
Implements kanzi::Node.
Reimplemented in kanzi::Viewport2D.
◆ getAbstractChildIndexOverride()
Implements kanzi::Node.
Reimplemented in kanzi::Viewport2D.
◆ getAbstractChildOverride()
|
overridevirtual |
Node::getAbstractChildOverride() implementation.
Implements kanzi::Node.
Reimplemented in kanzi::Viewport2D.
◆ removeAbstractChildOverride()
Node::removeAbstractChildOverride() implementation.
Implements kanzi::Node.
◆ moveAbstractChildToPositionOverride()
|
overridevirtual |
Node::moveAbstractChildToPosition() implementation.
Implements kanzi::Node.
◆ compositionRequiresAlpha()
|
inline |
Returns whether composition requires alpha.
- Returns
- If composition requires alpha, true, otherwise false.
◆ setCompositionRequiresAlpha()
Turns the composition alpha requirement on or off.
- Parameters
-
enabled To enable the composition alpha requirement, pass true. To disable the composition alpha requirement, pass false.
◆ compositionRequiresDepth()
|
inline |
Returns whether composition requires depth.
- Returns
- If composition requires depth, true, otherwise false.
◆ setCompositionRequiresDepth()
Turns the composition depth requirement on or off.
- Parameters
-
enabled To enable the composition depth requirement, pass true. To disable the composition depth requirement, pass false.
◆ compositionRequiresStencil()
|
inline |
Returns whether composition requires stencil.
- Returns
- If composition requires stencil, true, otherwise false.
◆ setCompositionRequiresStencil()
Turns the composition stencil requirement on or off.
- Parameters
-
enabled To enable the composition stencil requirement, pass true. To disable the composition stencil requirement, pass false.
◆ getBackgroundQuad()
|
inline |
Gets the background quad description.
This function returns a copy of the background quad struct. Use this function only for tests.
◆ getClippingArea()
|
inline |
Gets the clipping area.
This function returns a copy of the clipping struct. Use this function only for tests.
◆ getLayoutOpacity()
|
inline |
Gets the opacity after propagation from layouting hierarchy.
- Returns
- Current layouted opacity.
◆ getParentSpaceTransform()
|
inline |
Gets the parent space transform of the 2D node.
- Returns
- Parent space transform.
◆ getChildCompositionSpaceTransform()
|
inline |
Gets the transform used for composition children of the 2D node.
Kanzi uses the same transform for rendering the background and foreground of the node.
- Returns
- Child composition space transform.
◆ getRenderQuadTransform()
|
inline |
Gets transformation used to render the 2D node.
- Returns
- Transform used for rendering the quad.
◆ hasCenterClipArea()
|
inline |
Returns whether a 2D node has the center clip area (the area of foreground content).
- Returns
- If the node has the area, true, otherwise false.
◆ hasOutsideClipArea()
|
inline |
Returns whether a 2D node has outside clipping area.
This means any area outside the foreground content.
- Returns
- If the node has the area, true, otherwise false.
◆ hasTranslucentForeground()
|
inline |
Returns whether the foreground of a 2D node has translucency.
For the contributing flags, see setForegroundIsTranslucent() and setForegroundTranslucencyRequested().
- Returns
- If the foreground has translucency, true, otherwise false.
◆ setForegroundIsTranslucent()
Sets the status of the foreground translucency.
To combine the factors that determine translucency, Kanzi calculates this flag from layout time.
- Parameters
-
enabled To enable foreground translucency, pass true. To disable foreground translucency, pass false.
◆ setForegroundTranslucencyRequested()
Enables or disables the foreground translucency request.
Use this to request "extra" translucency in the updateRenderOverride() implementations of inherited classes. The extra request for translucency does not affect the default rendering of the foreground or background brush, but it can affect the format of the allocated composition target.
- Parameters
-
enabled To enable the foreground translucency request, pass true. To disable the foreground translucency request, pass false.
◆ setCompositionRequested()
Turns the composition request on or off.
This is a composition request from code, not by setting a property.
- Parameters
-
enabled To enable the composition request, pass true. To disable the composition request, pass false.
◆ setPotentialCompositionBitViewport()
Turns the potential composition flag for the viewport on or off.
- Parameters
-
enabled To enable the composition flag, pass true. To disable the composition flag, pass false.
◆ isClearColorAllowed()
|
inline |
Returns whether this Node2D is allowed and should clear the color buffer of its own composition target.
By default, clearing is allowed but can be explicitly denied by user using properties.
This function does not access the property, but a flag determined during layout.
◆ setClearColorAllowed()
Sets clear color allowed.
- Parameters
-
enabled To set clear color allowed, pass true. To set clear color not allowed, pass false.
◆ isRenderChildrenAllowed()
|
inline |
Returns whether rendering children is allowed.
- Returns
- If rendering children is allowed, true, otherwise false.
◆ isRenderSelfAllowed()
|
inline |
Returns whether render self is allowed.
- Returns
- If render self is allowed, true, otherwise false.
◆ isVisibleForHitTesting()
|
inline |
Returns whether a 2D node is visible for hit testing.
For a node to be visible for hit testing, that node must be visible and not be rendered off-screen.
- Returns
- If the node is visible for hit testing, true, otherwise false.
◆ requiresBackgroundBrushRendering()
|
inline |
Returns whether background brush rendering is required.
- Returns
- If background brush rendering is required, true, otherwise false.
◆ requiresForegroundBrushRendering()
|
inline |
Returns whether foreground brush rendering is required.
- Returns
- If foreground brush rendering is required, true, otherwise false.
◆ requiresLocalTransformationScope()
|
inline |
Indicates whether local transformation scope is required.
- Returns
- If local transformation scope is required, true, otherwise false.
◆ setRequiresLocalTransformationScope()
Sets the local transformation scope requirement.
- Parameters
-
enabled To enable, set to true. To disable, set to false.
◆ requiresTilingUpdate()
|
inline |
Returns whether node geometry requires an update for the tiling.
- Returns
- If an update is required for tiling, true, otherwise false.
- Since
- Kanzi 3.9.5
◆ setRequiresTilingUpdate()
Sets the tiling update requirement.
- Parameters
-
enabled To enable the tiling update requirement, set to true. To disable the tiling update requirement, set to false.
- Since
- Kanzi 3.9.5
◆ isSelfInCompositionTarget()
|
inline |
Returns whether the node is going to get rendered into a composition target.
- Returns
- If node is going the get rendered to a composition target, true, otherwise false.
◆ isCompositionPotentiallyRequired()
|
inline |
Tell if node itself is going to get rendered into a composition target.
- Returns
- If node is going the get rendered to a composition target true, otherwise false.
◆ getContentDesiredSize()
|
inline |
Gets the size desired by content.
- Returns
- Size vector.
◆ getSecondPassDesiredSize()
|
inline |
Gets the second pass desired size.
- Returns
- Size vector.
◆ getUserDesiredSize()
|
inline |
Gets the size desired by user.
- Returns
- Size vector.
◆ getPartialArrangeTransform()
|
inline |
Gets the partial arrange transform.
- Returns
- Propagate transform.
◆ isCompletelyClipped()
|
inline |
Returns whether a node is completely clipped and needs not be rendered.
- Returns
- If the node is completely clipped, true, otherwise false.
◆ isCompletelyTransparent()
|
inline |
Returns whether a node is completely transparent.
- Returns
- If the node is completely transparent, true, otherwise false.
◆ isPerspectiveTransformActive()
|
inline |
Returns whether a node is being perspective transformed.
- Returns
- If the node is being perspective transformed, true, otherwise false. Kanzi sets the internal active status during layout.
◆ initialize()
◆ acquireVisual()
|
protected |
Initializes and returns visual structure.
Allocates memory for rendering-related information. By default this information is unallocated.
◆ renderOverride()
|
protectedvirtual |
Node-specific top-level render call.
Allows for overriding the complete Node2D rendering process. Should normally not be overridden. Even if overridden, inherited implementations should usually call base implementation.
- Parameters
-
renderer Renderer. compositionStack Render context stack. baseTransform Optional additional transform in the composition space.
◆ renderRecursive()
|
protected |
◆ renderSelfOverride()
|
protectedvirtual |
Node-specific rendering.
Default implementation renders background normally and passes to foreground render. Inherit to render more complex forms. The base transform is optional. If it is set, Kanzi multiplies it with the transform of the node.
- Parameters
-
renderer Renderer. compositionStack Render context stack. baseTransform Transform applied to node itself in parent space.
Reimplemented in kanzi::Portal, kanzi::ProgressiveRenderingViewport2D, and kanzi::Viewport2D.
◆ renderChildren()
|
protected |
◆ renderBackground()
|
protected |
◆ renderForeground()
|
protected |
Renders the foreground of a Node2D.
Calls renderForegroundOverride().
- Parameters
-
renderer Renderer. compositionStack Render context stack. transform Transform used to render the foreground.
◆ renderForegroundOverride()
|
protectedvirtual |
Node-specific foreground render.
Default implementation renders the center clip area from using the assigned foreground brush.
- Parameters
-
renderer Renderer. compositionStack Render context stack. transform Transform used to render the foreground.
Reimplemented in kanzi::TextBox2D, and kanzi::TextBlock2D.
◆ pushLocalViewportArea()
|
protected |
Pushes local viewport and scissor area into composition stack if it is required.
Nodes with render type RenderTypeManual rely on viewport and scissoring settings to clip their output. This needs an additional composition area pushed to the composition stack.
- Parameters
-
compositionStack Composition stack. baseTransform Optional transform in composition space.
- Returns
- True if a new area was pushed into composition stack and needs to be popped after rendering.
◆ acquireCompositor()
|
protected |
Initializes and returns composition structure.
Allocates memory for all composition-related information. By default this information is unallocated.
- Returns
- Reference to the compositor.
◆ applyCompositionForRenderSelf()
|
protected |
Applies composition for rendering the node.
Used in the standard render path. Either applies the perspective projection or uses the current composition stack as-is. Can be used in inheriting classes implementing renderSelfOverride() but not wanting to re-invent perspective transform.
- Parameters
-
renderer Renderer. compositionStack Render context stack. baseTransform Transform applied to node itself in parent space.
- Returns
- Matrix to be passed to rendering the node.
◆ clearCompositionTarget()
|
protected |
Clears the composition target of a 2D node.
Kanzi executes this function before rendering the node into its composition target.
- Parameters
-
renderer Renderer to use. compositionStack Render context stack.
- Since
- Kanzi 3.9.6 removed
clearColorparameter.
◆ measureOverride()
Default implementation of Node2D size calculation.
Reimplemented in kanzi::Image2D, kanzi::Portal, kanzi::Viewport2D, kanzi::ContentLayout2D, kanzi::DockLayout2D, kanzi::FlowLayout2D, kanzi::GridLayout2D, kanzi::PrefabView2D, kanzi::StackLayout2D, kanzi::TextBlock2D, kanzi::TextBox2D, and kanzi::TrajectoryLayout2D.
◆ arrangeRecursive()
|
protectedvirtual |
Perform arrange recursively.
Reimplemented in kanzi::Viewport2D.
◆ arrangeOverride()
Default implementation of Node2D arrange.
Reimplemented in kanzi::ProgressiveRenderingViewport2D, kanzi::ContentLayout2D, kanzi::DockLayout2D, kanzi::FlowLayout2D, kanzi::GridLayout2D, kanzi::GridListBox2D, kanzi::Page, kanzi::StackLayout2D, kanzi::TextBlock2D, kanzi::TextBox2D, and kanzi::TrajectoryLayout2D.
◆ getUserAspectRatio()
|
protected |
Gets the value of the aspect ratio property assigned to a node.
Aspect ratio of 0 or smaller equals no aspect ratio set.
- Returns
- optional aspect ratio.
◆ getUserHeight()
|
protected |
Gets the value of the layout height property assigned to a node.
Having an offscreen render target overrides the default size of a node.
Sizes smaller than 0 are clamped to 0.
- Returns
- Optional height.
◆ getUserWidth()
|
protected |
Gets the value of the layout width property assigned to a node.
Having an offscreen render target overrides the default size of a node.
Sizes smaller than 0 are clamped to 0.
- Returns
- Optional width.
◆ getDesiredSizeAxisAlignedBoundingBoxMinimum()
|
inlineprotected |
Gets the desired size axis aligned bounding box minimum.
- Returns
- Desired size minimum.
◆ setDesiredSizeAxisAlignedBoundingBoxMinimum() [1/2]
Sets the desired size axis aligned bounding box minimum.
- Parameters
-
size New size vector.
◆ setDesiredSizeAxisAlignedBoundingBoxMinimum() [2/2]
|
inlineprotected |
Sets the desired size axis aligned bounding box minimum.
- Parameters
-
sizeX New desired minimum size X component. sizeY New desired minimum size Y component.
◆ getDesiredSizeAxisAlignedBoundingBoxMaximum()
|
inlineprotected |
Gets the desired size axis aligned bounding box maximum.
- Returns
- Desired size maximum.
◆ setDesiredSizeAxisAlignedBoundingBoxMaximum() [1/2]
Sets the desired size axis aligned bounding box maximum.
- Parameters
-
size New size vector.
◆ setDesiredSizeAxisAlignedBoundingBoxMaximum() [2/2]
|
inlineprotected |
Sets the desired size maximum.
- Parameters
-
sizeX New desired maximum size X component. sizeY New desired maximum size Y component.
◆ calculateTransformedBoundingArea()
|
protected |
Calculates new transformed bounding area.
- Parameters
-
transform Matrix to use for calculation. sizeIn Input size.
◆ updateFinalTransform()
|
protected |
Updates the transformation status based on node properties and calculations in measure and arrange phases.
Called from within updateRender() if necessary (if transform has changed). Kanzi stores all calculated transforms into node fields.
- Parameters
-
worldTransform Transformation in world space. parentTransform Parent's transformation in its composition space.
◆ updateRender()
|
protected |
Validates a node for rendering.
This is the final part of layouting. (Re)Calculate transformation components, decide whether to render to a framebuffer object, and so on.
Kanzi recalculates transformations only if the transform of the node or its parent changed.
- Parameters
-
worldTransform Transformation in world space. parentTransform Transformation in parent space. transformChanged Indicates whether the transform of the node or its parent changed and needs updating.
- Returns
- If there are additional reasons detected during transform to propagate the transformation process downward, true, otherwise false.
◆ updateRenderOverride()
Node-specific updates done before render.
Reimplemented in kanzi::Image2D, kanzi::ProgressiveRenderingViewport2D, kanzi::Viewport2D, kanzi::TextBlock2D, and kanzi::TextBox2D.
◆ calculateContentStretch()
|
protected |
Calculates content stretch.
- Parameters
-
renderSize Rendering area size. contentSize Size of content rendered to rendering area.
- Returns
- Optional foreground quad, if it is relevant.
◆ calculateClippingArea()
|
protected |
Calculates clipping parameters.
- Returns
- New clipping parameters.
◆ performClipping()
|
protected |
Performs rectangle clipping.
- Parameters
-
backgroundQuad Background quad, modified in-place. foregroundQuad Optional foreground quad, modified in-place. effectQuad Optional effect quad, modified in-place. clippingResult Current clipping result mask.
- Returns
- Clipping mask.
◆ onTransform()
◆ onAttached()
|
overrideprotectedvirtual |
Node::onDetached() implementation.
Reimplemented from kanzi::Node.
Reimplemented in kanzi::ProgressiveRenderingViewport2D, kanzi::Screen, kanzi::Viewport2D, kanzi::Page, kanzi::PageHost, kanzi::TextBlock2D, and kanzi::TextBox2D.
◆ onDetached()
|
overrideprotectedvirtual |
Node::onDetached() implementation.
Reimplemented from kanzi::Node.
Reimplemented in kanzi::ProgressiveRenderingViewport2D, kanzi::Screen, kanzi::Viewport2D, kanzi::TextBoxConceptImpl< Node2D, TextBox2D, TextBox2DTraits >, kanzi::ToggleButtonGroupConceptImpl< Node2D, ToggleButtonGroup2D >, kanzi::Page, kanzi::PageHost, and kanzi::TextBlock2D.
◆ onNodePropertyChanged()
|
overrideprotectedvirtual |
Node::onNodePropertyChanged implementation.
Reimplemented from kanzi::Node.
Reimplemented in kanzi::Screen, kanzi::Viewport2D, kanzi::PrefabViewConceptImpl< Node2D, PrefabView2D >, kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >, kanzi::TextBlockConceptImpl< Node2D, TextBlock2D >, kanzi::TextBoxConceptImpl< Node2D, TextBox2D, TextBox2DTraits >, kanzi::ToggleButtonGroupConceptImpl< Node2D, ToggleButtonGroup2D >, kanzi::TrajectoryLayoutConceptImpl< Node2D, TrajectoryLayout2D >, kanzi::PageHost, kanzi::TextBlock2D, and kanzi::TextBox2D.
◆ restoreResources()
|
overrideprotectedvirtual |
Node::restoreResources() implementation.
Reimplemented from kanzi::Node.
Reimplemented in kanzi::ProgressiveRenderingViewport2D, and kanzi::Viewport2D.
◆ isEmptyActualSize()
|
inlineprotected |
Returns whether the size of the node is empty or invalid.
Node must have positive size, greater than zero on both axes to be considered having a non-empty size.
Having empty size prevents rendering of node itself but not of its children.
◆ isForegroundHintOpaque()
|
inlineprotected |
Indicates whether foreground hint is opaque.
- Returns
- If foreground hint is opaque, true, otherwise false.
◆ isForegroundHintTranslucent()
|
inlineprotected |
Indicates whether foreground hint is translucent.
- Returns
- If foreground hint is translucent, true, otherwise false.
◆ setPartialArrangeTransform()
Sets partial arrange transform.
If the transform has changed, invalidates final transformation.
- Parameters
-
transform The partial arrange transform to set.
◆ setRenderChildrenAllowed()
Turn render children on or off.
- Parameters
-
enabled True to turn on, false to turn off.
◆ setRenderSelfAllowed()
Turn render self on or off.
- Parameters
-
enabled True to turn on, false to turn off.
◆ setRenderType()
|
inlineprotected |
Set render type.
- Parameters
-
renderType Render type.
◆ updateContentTexture()
|
inlineprotected |
Update content texture for the foreground brush.
◆ setSecondPassDesiredSize()
Set second pass desired size.
- Parameters
-
size New size vector.
◆ calculatePerspectiveTransformMatrices()
|
inlineprotected |
Calculate perspective transform matrices.
This is a testing support function and should not be used by user code.
- Returns
- true if a perspective transform exists. In this case the cameraMatrix and projectionMatrix arguments are set to the final matrices based on the specified viewport size.
◆ setEffect()
|
inlineprotected |
Sets the value of EffectProperty.
- Since
- Kanzi 3.9.0
Friends And Related Symbol Documentation
◆ Screen
◆ Viewport3D
|
friend |
◆ doListBoxArrange
Member Data Documentation
◆ AspectRatioProperty
|
static |
◆ ForceCompositionProperty
|
static |
ForceComposition property.
The default value is false.
◆ ForegroundHintProperty
|
static |
ForegroundHint property.
The default value is Node2D::ForegroundHintNone.
- See also
- setForegroundHint(), getForegroundHint()
◆ OffscreenRenderingProperty
|
static |
OffscreenRendering property.
The default value is false.
◆ DisableRenderTargetClearProperty
|
static |
DisableRenderTargetClear property.
The default value is false.
◆ PixelFormatProperty
|
static |
PixelFormat property.
The default value is Node2D::PixelFormatRgb.
- See also
- setPixelFormat(), getPixelFormat()
◆ RenderSelfProperty
|
static |
◆ RenderTargetProperty
|
static |
RenderTarget property.
The default value is ResourceSharedPtr().
- See also
- setRenderTarget(), getRenderTarget()
◆ RenderTargetMinimumHeightProperty
|
static |
RenderTargetMinimumHeight property.
The default value is 1.0f.
◆ RenderTargetMinimumWidthProperty
|
static |
RenderTargetMinimumWidth property.
The default value is 1.0f.
◆ RenderTargetReallocationLimitProperty
|
static |
RenderTargetReallocationLimit property.
The default value is 0.25f.
◆ CachingModeProperty
|
static |
Sets the caching mode:
- CachingModeDisabled disables caching and sets Kanzi to render the node and its descendants normally.
- CachingModeEnabled enables caching and sets Kanzi to use the cache until you invalidate it.
- CachingModeAutomatic sets Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change.
- Since
- Kanzi 3.9.0
◆ CacheValidProperty
|
static |
Kanzi sets the value of this property to indicate whether the node is cached.
To disable the cache for one frame, set this property to false. The default value is false.
- See also
- setCacheValid(), isCacheValid()
- Since
- Kanzi 3.9.0
◆ LayoutTransformationProperty
|
static |
◆ RenderTransformationProperty
|
static |
◆ PerspectiveTransformationProperty
|
static |
Sets the perspective transformation of the node.
The default value is identity.
◆ PerspectiveTransformationModeProperty
|
static |
Sets the perspective transformation mode of the node.
The default value is Screen.
◆ PerspectiveTransformationFovProperty
|
static |
PerspectiveTransformationFov property.
The default value is 45.
◆ PerspectiveTransformationPivotProperty
|
static |
PerspectiveTransformationOrigin property.
The default value is 0.0,0.0,0.0.
◆ PerspectiveTransformationOriginProperty
|
static |
PerspectiveTransformationOrigin property.
The default value is 0.0,0.0,0.0.
◆ RenderTransformationOriginProperty
|
static |
RenderTransformationOrigin property.
The default value is Vector2(0.0f, 0.0f).
◆ SnapToPixelProperty
|
static |
◆ BackgroundBrushProperty
|
static |
BackgroundBrush property.
The default value is ResourceSharedPtr().
- See also
- setBackgroundBrush(), getBackgroundBrush()
◆ CompositionBrushProperty
|
static |
CompositionBrush property.
The default value is ResourceSharedPtr().
◆ ForegroundBrushProperty
|
static |
ForegroundBrush property.
The default value is ResourceSharedPtr().
- See also
- setForegroundBrush(), getForegroundBrush()
◆ EffectProperty
|
static |
Reports the runtime effect instance used by the node, instantiated from the NodeEffectPrefab2D.
Kanzi sets this property internally whenever the value of the EffectPrefabProperty changes. The default value is ResourceSharedPtr()
- See also
- setEffect(), getEffect()
- Since
- Kanzi 3.9.0
◆ EffectPrefabProperty
|
static |
Sets the 2D Effect prefab to use for the node.
The default value is ResourceSharedPtr()
- See also
- setEffectPrefab(), getEffectPrefab()
- Since
- Kanzi 3.9.0
◆ MultisampleLevelProperty
|
static |
Sets the number of anti-aliasing samples to use for temporary composition targets.
The default value is NoMSAA.
- Since
- Kanzi 3.9.7
◆ m_visual
|
protected |
Visual information.
◆ m_compositor
|
protected |
Composition and caching information.
◆ m_backgroundQuadDescription
|
protected |
Background clipping quad / composition quad description.
◆ m_effectQuadDescription
|
protected |
Effect quad description.
◆ m_cachedEffect
|
protected |
Cached effect instance.
◆ m_validatedEffectPaddingChangeCounter
Effect padding change counter value at which effect quad was last validated.
◆ m_clipping
|
protected |
Clipping parameters.
◆ m_compositionRequirements
|
protected |
Composition requirements for this 2D node.
◆ m_currentEffectPrefab
|
protected |
Currently instantiated effect prefab.
The documentation for this class was generated from the following file:
- kanzi/core.ui/node/node2d.hpp